package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.AttendExtraJsonAddDTO;
import org.jsola.hr.dto.AttendExtraJsonUpdateDTO;
import org.jsola.hr.query.AttendExtraJsonQuery;
import org.jsola.hr.vo.AttendExtraJsonListVO;
import org.jsola.hr.vo.AttendExtraJsonVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-考勤方案额外数据")
public interface IAttendExtraJsonControllerAPI {

    /**
     * 新增考勤方案额外数据
     * @param attendExtraJsonAddDTO 考勤方案额外数据新增实体
     * @return 考勤方案额外数据展示对象
     */
    @ApiOperation(value = "新增考勤方案额外数据")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendExtraJsonAddDTO", dataType = "AttendExtraJsonAddDTO", value = "新增考勤方案额外数据", paramType = "body")
    })
    Result<AttendExtraJsonVO> save(AttendExtraJsonAddDTO attendExtraJsonAddDTO);


    /**
     * 修改考勤方案额外数据
     * @param attendExtraJsonUpdateDTO 考勤方案额外数据
     * @return 更新数量
     */
    @ApiOperation(value = "修改考勤方案额外数据")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendExtraJsonUpdateDTO", dataType = "AttendExtraJsonUpdateDTO", value = "修改考勤方案额外数据", paramType = "body")
    })
    Result<Integer> update(AttendExtraJsonUpdateDTO attendExtraJsonUpdateDTO);




    /**
     * 删除单个考勤方案额外数据，彻底删除
     * @param attendExtraJsonId 考勤方案额外数据id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个考勤方案额外数据，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendExtraJsonId", dataType = "String", value = "考勤方案额外数据id", paramType = "path")
    })
    Result<Integer> delete(String attendExtraJsonId);


    /**
     * 批量删除考勤方案额外数据，彻底删除
     * @param attendExtraJsonIds 考勤方案额外数据id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除考勤方案额外数据，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendExtraJsonIds", dataType = "String[]", value = "考勤方案额外数据id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] attendExtraJsonIds);


    /**
     * 根据考勤方案额外数据id查询考勤方案额外数据详情
     * @param attendExtraJsonId 考勤方案额外数据id
     * @return 考勤方案额外数据详情
     */
    @ApiOperation(value="根据考勤方案额外数据id查询考勤方案额外数据详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendExtraJsonId", dataType = "String", value = "考勤方案额外数据id", paramType = "path")
    })
    Result<AttendExtraJsonVO> findById(String attendExtraJsonId);


    /**
     * 查询考勤方案额外数据
     * @param attendExtraJsonQuery 考勤方案额外数据查询参数
     * @return page
     */
    @ApiOperation(value="查询考勤方案额外数据")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendExtraJsonQuery", dataType = "AttendExtraJsonQuery", value = "考勤方案额外数据查询参数", paramType = "query")
    })
    Result<List<AttendExtraJsonListVO>> listAll(AttendExtraJsonQuery attendExtraJsonQuery);


     /**
     * 分页查询考勤方案额外数据
     * @param attendExtraJsonQuery 考勤方案额外数据查询参数
     * @return page
     */
    @ApiOperation(value="分页查询考勤方案额外数据")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendExtraJsonQuery", dataType = "AttendExtraJsonQuery", value = "考勤方案额外数据查询参数", paramType = "query")
    })
    Result<Page<AttendExtraJsonListVO>> page(AttendExtraJsonQuery attendExtraJsonQuery);


}

